Skip to content

docs: document partial-failures.json for multi-version bootstrap - #1321

Merged
LalatenduMohanty merged 1 commit into
python-wheel-build:mainfrom
LalatenduMohanty:docs/1320-partial-failures-docs
Sep 8, 2026
Merged

docs: document partial-failures.json for multi-version bootstrap#1321
LalatenduMohanty merged 1 commit into
python-wheel-build:mainfrom
LalatenduMohanty:docs/1320-partial-failures-docs

Conversation

@LalatenduMohanty

@LalatenduMohanty LalatenduMohanty commented Sep 8, 2026

Copy link
Copy Markdown
Member

Document the new multi-version failure artifact, its schema, cleanup behavior, and interaction with test mode.

Closes: #1320

Pull Request Description

What

Why

@LalatenduMohanty @codex
docs: document partial-failures.json for multi-version bootstrap
6783b3c 
Document the new multi-version failure artifact, its schema, cleanup behavior, and interaction with test mode.

Closes: python-wheel-build#1320

Co-Authored-By: Codex <codex@openai.com>
Signed-off-by: Lalatendu Mohanty <lmohanty@redhat.com>
@LalatenduMohanty
LalatenduMohanty requested a review from a team as a code owner September 8, 2026 18:09
@LalatenduMohanty
LalatenduMohanty marked this pull request as draft September 8, 2026 18:09
@coderabbitai

coderabbitai Bot commented Sep 8, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 066b70f1-7d6a-4d22-96e6-0a801d5bef20

📥 Commits

Reviewing files that changed from the base of the PR and between 1a8e805 and 6783b3c.

📒 Files selected for processing (2)
  • docs/how-tos/multiple-version-bootstrap.rst
  • docs/proposals/test-mode.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

Walkthrough

The documentation now describes partial-failures.json for multi-version bootstrap, including its creation, cleanup, fields, and JSON structure. It also documents behavior when --test-mode and --multiple-versions are combined. The test-mode proposal distinguishes test-mode failure reports from multi-version partial failure reports.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to 6783b

The documentation now explains multi-version partial-failure reports and their relationship to test-mode output without changing runtime behavior. No current merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Linked Issues check ❓ Inconclusive The changes address the linked issue's documentation scope, including the artifact, report fields, cleanup behavior, test-mode interaction, schema example, and release information. The provided summar… Confirm that the documentation explicitly states that unresolved requirements use a null version.
✅ Passed checks (3 passed)
Check name Status Explanation
Out of Scope Changes check ✅ Passed The changes are limited to documentation updates directly related to the linked issue. No unrelated code or content changes are identified.
Title check ✅ Passed The title clearly and concisely identifies the documentation change for the multi-version bootstrap partial-failures.json artifact.
Description check ✅ Passed The description is related to the changeset and identifies the documented artifact, schema, cleanup behavior, and test-mode interaction.
Full details: Linked Issues check

Explanation

The changes address the linked issue's documentation scope, including the artifact, report fields, cleanup behavior, test-mode interaction, schema example, and release information. The provided summary does not confirm that unresolved requirements are documented with a null version.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@LalatenduMohanty LalatenduMohanty mentioned this pull request Sep 8, 2026
Merged
4 tasks
rd4398
rd4398 approved these changes Sep 8, 2026
View reviewed changes

@rd4398 rd4398 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@LalatenduMohanty
LalatenduMohanty marked this pull request as ready for review September 8, 2026 18:22
@LalatenduMohanty
LalatenduMohanty merged commit 2d1b2f9 into python-wheel-build:main Sep 8, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ryanpetrello ryanpetrello ryanpetrello approved these changes
@rd4398 rd4398 rd4398 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docs: document partial-failures.json for multi-version bootstrap

3 participants

@LalatenduMohanty @ryanpetrello @rd4398